/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.reliable.events;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
/** This event is issued by the reliable delivery service, in response to the 
    ACKs that it has received so far from the entity. 

    The ACKResponse contains among other things, information regarding
    (a) sync-point advance for the entity. 
    (b) missed sequences. The acknowledgements might be lost in transit - 
    the reliable delivery service considers these events to have been lost
    in transit. 
    
    @author Shrideep Pallickara
    $Date$
    $Revision$

*/

public class RdAckResponseServiceInvoiceEvent {
  /** The sync as returned by the reliable delivery service */
  private long sync;

  /** Lists the number of missed sequences contained in this event */
  private int numOfMissedSequences;

  /** Lists the missed sequences */
  private long[] missedSequences=null;

  private long missedSequence=0;
  private boolean missedSequenceInfo = false;
  private boolean singleSequenceInfo=true;

  private int templateId;
  private int entityId;

  private String moduleName = "RdAckResponseServiceInvoiceEvent: ";

  public RdAckResponseServiceInvoiceEvent(int templateId, int entityId,
					  long sync) {
    this.templateId = templateId;
    this.entityId = entityId;
    this.sync = sync;
  }


  public int getTemplateId() {
    return templateId;
  }

  public int getEntityId() {
    return entityId;
  }

  /** Retrieves the sync point associated with the entity in question. */
  public long getSyncpoint() {
    return sync;
  }

  /** Indicates if this event encapsulates Nak information */
  public boolean containsMissedSequenceInfo() {
    return missedSequenceInfo;
  }
  
  
  /** Iff this event encapsulates Nak information, this method indicates if 
      the entity has missed a single sequence or multiple sequences */
  public boolean containsSingleSequenceInfo() {
    return singleSequenceInfo;
  }

  /** Returns the missed sequence. Will return 0 if there are is no missed
      sequence or if there are multiple missed sequences */
  public long getMissedSequence() {
    return missedSequence;
  }


  /** Sets the missing sequence information */
  public void setMissedSequence(long missedSequence) {
    this.missedSequence = missedSequence;
    missedSequences = null;
    missedSequenceInfo=true;
    singleSequenceInfo = true;
  }


  /** Returns the missed sequences. Will return null, if there is no missed
      sequence or if there are no multiple missed sequences */
  public long[] getMissedSequences() {
    return missedSequences;
  }


  /** Sets information pertaining to multiple missed sequences */
  public void setMissedSequences(long[] missedSequences) {
    this.missedSequences = missedSequences;
    missedSequence = 0;
    missedSequenceInfo=true;
    singleSequenceInfo=false;
  }

  public RdAckResponseServiceInvoiceEvent(byte[] marshalledBytes) {
     ByteArrayInputStream baInputStream = 
      new ByteArrayInputStream(marshalledBytes);
    DataInputStream din = new DataInputStream(baInputStream);

    try {
      din.readByte();/*ReliableDeliveryX.RDS_ACK_RESPONSE_INVOICE_EVENT*/
      
      templateId = din.readInt();
      entityId = din.readInt();
      sync = din.readLong();
      missedSequenceInfo = din.readBoolean();
      
      if (missedSequenceInfo) {
	singleSequenceInfo = din.readBoolean();
	if (singleSequenceInfo) {
	  missedSequence = din.readLong();
	} else {
	  int _seqLength = din.readInt();
	  missedSequences = new long[_seqLength];
	  for (int i=0; i< _seqLength; i++) {
	    missedSequences[i] = din.readLong();
	  }/*end for */
	}/*end singleSequenceInfo*/
      }/*end missed Sequence info */

    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while un-marshalling");
    }

  }

  
  /** Gets the serialized representation of the event */
  public byte[] getBytes() {
    ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
    DataOutputStream dout = new DataOutputStream(baOutputStream);
    byte[] marshalledBytes= null;
    try {
      dout.writeByte(ReliableDeliveryExchange.RDS_ACK_RESPONSE_INVOICE_EVENT);
      
      dout.writeInt(templateId);
      dout.writeInt(entityId);

      dout.writeLong(sync);
      
      dout.writeBoolean(missedSequenceInfo);
      
      if (missedSequenceInfo) {
	dout.writeBoolean(singleSequenceInfo);
	if (singleSequenceInfo) {
	  dout.writeLong(missedSequence);
	} else {
	  dout.writeInt(missedSequences.length);
	  for (int i=0; i<missedSequences.length; i++) {
	    dout.writeLong(missedSequences[i]);
	  }/*end for */
	}/*end singleSequenceInfo*/
      }/*end missed Sequence info */
      
      marshalledBytes = baOutputStream.toByteArray();
    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while marshalling");
    } /** end try-catch block*/
    
    return marshalledBytes;


  }
  

  public String toString() {
    String stringRep = moduleName + "TemplateId=" + templateId + 
      ", EntityId=" + entityId + ", Advance SYNC=" + sync;
    
    if (missedSequenceInfo) {
      stringRep += " Missed Sequences =";
      
      if (singleSequenceInfo) {
	stringRep += ("[" + missedSequence + "]" );
      } else {
	for (int i = 0; i < missedSequences.length ; i++) {
	  stringRep += ("[" + missedSequences[i] + "] " );
	}/*end for */
      }/*end singleSequenceInfo */
      
    }/*end missedSequenceInfo */
    
    
    return stringRep;
  }
  
}
